Patient Segmentation Process API - Implementation Template
Setup guide
Importing Templates into Anypoint Studio
- In Studio, click the Exchange X icon in the upper left of the taskbar.
- Log in with your Anypoint Platform credentials.
- Search for the template.
- Click Open.
Running Templates in Anypoint Studio
After you import your template into Studio, follow these configuration steps to run it.
Common Configuration
mule.env
- sets the environment where the application is to be deployed. It should be configured inconfig-<mule.env>.yaml
file. For a studio deployment, the recommended mule.env value islocal
.mule.key
- sets the encryption password to be used for encrypting secure properties. Update as needed.api.autodiscoveryID
should be configured inconfig-<mule.env>.yaml
file.
Please refer to the attached link on how to secure the configuration properties.
Patient Segmentation Process API Configuration
The application requires a few things to be configured such as SFTP and external services connection information. Configure them in the properties file located in the config/properties
folder.
SFTP Configuration
sftp.host
should be configured inconfig-<mule.env>.yaml
file.sftp.port
should be configured inconfig-<mule.env>.yaml
file.sftp.username
should be configured inconfig-<mule.env>.yaml
file.sftp.password
should be configured inconfig-secured-<env>.yaml
file.
Salesforce CDP System API
cdp-sys-api.host
should be configured inconfig-<mule.env>.yaml
file. The API host.cdp-sys-api.port
should be configured inconfig-<mule.env>.yaml
file. The API port.cdp-sys-api.basepath
should be configured inconfig-<mule.env>.yaml
file. The API base path.cdp-sys-api.responseTimeout
should be configured inconfig-<mule.env>.yaml
file. The connection response timeout.cdp-sys-api.reconnection.frequency
should be configured inconfig-<mule.env>.yaml
file. The reconnection frequency.cdp-sys-api.reconnection.attempts
should be configured inconfig-<mule.env>.yaml
file. The reconnection attempts.
Azure Patient Engagement System API
azure-patient-engmt-sys-api.hostName
should be configured inconfig-<mule.env>.yaml
file. The API host.azure-patient-engmt-sys-api.port
should be configured inconfig-<mule.env>.yaml
file. The API port.azure-patient-engmt-sys-api.basepath
should be configured inconfig-<mule.env>.yaml
file. The API base path.azure-patient-engmt-sys-api.responseTimeout
should be configured inconfig-<mule.env>.yaml
file. The connection response timeout.azure-patient-engmt-sys-api.reconnection.frequency
should be configured inconfig-<mule.env>.yaml
file. The reconnection frequency.azure-patient-engmt-sys-api.reconnection.attempts
should be configured inconfig-<mule.env>.yaml
file. The reconnection attempts.
Source system data loads
This Process API interacts with multiple systems. Since the format to load data in to each of the systems is different, a set of sample data files have been provided for reference.
Refer the sample data format files available under src/test/samples
- Immunizations_Sample.csv
- Sample file that describes the structure of the patient immunizations.
- Conditions_Sample.csv
- Sample file that describes the structure of the patient conditions.
Run the application
- Right-click the template project folder.
- Hover your mouse over 'Run as'.
- Click Mule Application (configure).
- Inside the dialog, select Environment and set the variable
mule.env
to the appropriate value (dev or local). - Inside the dialog, select Environment and set the variable key to the property encryption key that you used to encrypt your secure properties.
- Click Run.
Deployment instructions for CloudHub using provided scripts
Ensure the Maven profile CloudHub-DEV
has been properly configured in your settings.xml
file. Reference can be found by downloading the Accelerator Setup Guide asset. Additional instructions are available in Accelerator Setup Guide - Configuring the Accelerator Build
section.
Update the config-<env>.yaml
properties appropriately and then use one of the following scripts to deploy the application to CloudHub:
- packageDeploy.sh or deployOnly.sh (Mac/Linux).
- packageDeploy.cmd or deployOnly.cmd (Windows).